Edit Task: SetPossibility ResourceBreakdownModes
Description
The SetPossibility ResourceBreakdownModes attribute under EditTask defines the usable resource state breakdown modes for a single task possibility.
Parameters
| Parameter | Description |
|---|---|
| PossibilityName | A string of text with a comma delimited list of resources in the possibility. Order is not required and the resource names should not be in quotes. |
| ResourceName | A string of text of the resource that is being defined within the command. |
| Applies | A Boolean value that determines whether body state modes are applicable. |
| Modes | A string of text of a comma delimited list of usable body modes. Empty string is allowed if the Applies value is false. A mode name specified that is not already part of the predefined modes for the resource will be added dynamically to the associated resource's capacity state definition permanently as the next free enumerated mode index. |
Examples
Set usable modes during the breakdown of a task for ResA in the possibility containing ResA and ResB.
PATCH api/task/TaskA
Body:
{
"SetResourceDetails" : {
"PossibilityName" : "ResA,ResB",
"ResourceName" : "ResA",
"BreakdownModes" : {
"Applies" : "TRUE",
"Modes" : "Red,Green" }
}
}
